DigiOffice Gateway Web Services

<back to all web services

GetProjectDetailsTBI

Get project details

Requires Authentication
The following routes are available for this service:
GET/api/tbi/Projects/{ID}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Veld:
    name: Optional[str] = None
    type: Optional[str] = None
    value: Optional[Object] = None
    description: Optional[str] = None
    global_i_d: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProjectDetailsTBI:
    velden: Optional[List[Veld]] = None


# @Api(Description="Get project details")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetProjectDetailsTBI:
    """
    Get project details
    """

    # @ApiMember(Description="ID or GlobalID", IsRequired=true)
    id: Optional[str] = None
    """
    ID or GlobalID
    """

Python GetProjectDetailsTBI DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/tbi/Projects/{ID} HTTP/1.1 
Host: kpm_digiofficeapigateway.tbi.nl 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProjectDetailsTBI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DO.API.TBI.API.DTO">
  <Velden>
    <Veld>
      <Description>String</Description>
      <GlobalID>00000000-0000-0000-0000-000000000000</GlobalID>
      <Name>String</Name>
      <Type>String</Type>
      <Value />
    </Veld>
  </Velden>
</ProjectDetailsTBI>